These are the keywords associated with each Natural Docs comment type. They are not case sensitive and are interchangable within their comment type. Using "sub: Multiply" is exactly the same as using "Function: Multiply" so you can use whichever is most natural to you. The plural forms are used for list comments where every item in their definition lists are linkable as if they had their own comment.
General Keywords
| | File | file | files | program | programs | script | scripts | document | documents | doc | docs | header | headers |
| | |
Code Keywords
Class | class | classes | package | packages | namespace | namespaces |
Struct | struct | structs | structure | structures |
Enum | enum | enums | enumeration | enumerations |
| Function | function | functions | func | funcs | procedure | procedures | proc | procs | routine | routines | subroutine | subroutines | sub | subs | method | methods | callback | callbacks | constructor | constructors | destructor | destructors |
Property | property | properties | prop | props |
Constant | constant | constants | const | consts |
Macro | macro | macros | define | defines | def | defs |
| Variable | variable | variables | var | vars | integer | integers | int | ints | uint | uints | long | longs | ulong | ulongs | short | shorts | ushort | ushorts | byte | bytes | ubyte | ubytes | sbyte | sbytes | float | floats | double | doubles | real | reals | decimal | decimals | scalar | scalars | array | arrays | arrayref | arrayrefs | hash | hashes | hashref | hashrefs | table | tables | bool | bools | booleans | booleans | flag | flags | bit | bits | bitfield | bitfields | field | fields | pointer | pointers | ptr | ptrs | reference | references | ref | refs | object | objects | obj | objs | character | charaters | char | chars | wcharacter | wcharacters | wchar | wchars | string | strings | str | strs | wstring | wstrings | wstr | wstrs | handle | handles |
|
Database Keywords
| Table | database table | database tables | databasetable | databasetables | db table | db tables | dbtable | dbtables |
| View | database view | database views | databaseview | databaseviews | db view | db view | dbviews | dbviews |
|
Field | database field | database fields | databasefield | databasefields | db field | db fields | dbfield | dbfields | database column | database columns | databasecolumn | databasecolumns | db column | db column | dbcolumn | dbcolumn |
| Cursor | database cursors | database cursors | databasecursor | databasecursors | db cursor | db cursors | dbcursor | dbcursors |
| Trigger | database triggers | database triggers | databasetrigger | databasetriggers | db trigger | db triggers | dbtrigger | dbtriggers |
|
Index | database index | database indexes | database indices | databaseindex | databaseindexes | databaseindices | db index | db indexes | db indices | dbindex | dbindexes | dbindices | database key | database keys | databasekey | databasekeys | db key | db keys | dbkey | dbkeys | database primary key | database primary keys | databaseprimarykey | databaseprimarykeys | db primary key | db primary keys | dbprimarykey | dbprimarykeys |
| |